Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add changelog update to publishing steps #14421

Merged
merged 2 commits into from
Jul 19, 2022

Conversation

jdpgrailsdev
Copy link
Contributor

What

  • Ensure that the connector changelog is updated when an update is published

How

  • Add a note about updating the connector changelog to publishing instructions.

Recommended reading order

  1. README.md

@jdpgrailsdev jdpgrailsdev requested a review from tuliren July 5, 2022 17:24
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Jul 5, 2022
docs/connector-development/README.md Outdated Show resolved Hide resolved
@@ -131,7 +131,8 @@ Once you've finished iterating on the changes to a connector as specified in its

* Then run the command `./gradlew :airbyte-config:init:processResources` to generate the seed spec yaml files, and commit the changes to the PR. See [this readme](https://github.com/airbytehq/airbyte/tree/a534bb2a8f29b20e3cc7c52fef1bc3c34783695d/airbyte-config/specs) for more information.

5. The new version of the connector is now available for everyone who uses it. Thank you!
5. OPTIONAL: If the `README.md` file of the connector contains a `Changelog` section, add the new version and relevant release information to the table in the section.
6. The new version of the connector is now available for everyone who uses it. Thank you!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This kind of depends on steps 4 because it will be harder to use if it is not in the mask.

@jdpgrailsdev jdpgrailsdev merged commit 735f77d into master Jul 19, 2022
@jdpgrailsdev jdpgrailsdev deleted the jonathan/connector-changelog branch July 19, 2022 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants